Create a placement

POST

placements

Create a placement

curl --request POST \
  --url https://your_a2_service/placements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaign_permission": {
    "black": [],
    "white": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "display": {
    "clktype": 1,
    "displayfmt": {
      "ext": {},
      "h": 250,
      "w": 300
    },
    "h": 250,
    "mime": [],
    "nativefmt": {
      "ext": {}
    },
    "w": 300
  },
  "ext": {
    "approval_method": "admin",
    "display": {
      "enabled": 0
    },
    "native": {
      "enabled": 0
    },
    "payout": "rates",
    "responsive": "fixed",
    "target_ecpm": 0,
    "video": {
      "enabled": 0
    }
  },
  "is_active": false,
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "video": {
    "clktype": 1,
    "ctype": [
      2
    ],
    "delay": 0,
    "h": 300,
    "linear": 0,
    "maxdur": 0,
    "mime": [],
    "mindur": 0,
    "playmethod": [],
    "ptype": 1,
    "skip": 0,
    "skipafter": 0,
    "skipmin": 0,
    "w": 480
  }
}'

{
  "campaign_permission": {
    "black": [],
    "white": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "display": {
    "clktype": 1,
    "displayfmt": {
      "ext": {},
      "h": 250,
      "w": 300
    },
    "h": 250,
    "mime": [],
    "nativefmt": {
      "ext": {}
    },
    "w": 300
  },
  "ext": {
    "approval_method": "admin",
    "display": {
      "enabled": 0
    },
    "native": {
      "enabled": 0
    },
    "payout": "rates",
    "responsive": "fixed",
    "target_ecpm": 0,
    "video": {
      "enabled": 0
    }
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": false,
  "name": "<string>",
  "no": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "video": {
    "clktype": 1,
    "ctype": [
      2
    ],
    "delay": 0,
    "h": 300,
    "linear": 0,
    "maxdur": 0,
    "mime": [],
    "mindur": 0,
    "playmethod": [],
    "ptype": 1,
    "skip": 0,
    "skipafter": 0,
    "skipmin": 0,
    "w": 480
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for creating placement entity.

created_by

string<uuid>

required

The ID of the user who created the placement

name

string

required

The name of the placement

campaign_permission

object

Permission

Show child attributes

created_at

string<date-time> | null

The date and time the entity was created.

description

string | null

The description in JSON Quill Delta format - a JSON format that represents rich text content

Links: https://quilljs.com/docs/delta

display

object

Schema for display placement. It contains specifications for banner display formats, native formats, and other display-related properties.

Show child attributes

ext

object

Schema for placement default extra configuration.

Show child attributes

is_active

boolean

default:false

updated_at

string<date-time> | null

The date and time the entity was last updated.

video

object

Schema for video placement. It contains specifications for video placement formats, and other video-related properties.

Show child attributes

Response

Successful Response

Schema for placement entity.

created_by

string<uuid>

required

The ID of the user who created the placement

name

string

required

The name of the placement

integer

required

campaign_permission

object

Permission

Show child attributes

created_at

string<date-time> | null

The date and time the entity was created.

description

string | null

The description in JSON Quill Delta format - a JSON format that represents rich text content

Links: https://quilljs.com/docs/delta

display

object

Schema for display placement. It contains specifications for banner display formats, native formats, and other display-related properties.

Show child attributes

ext

object

Schema for placement default extra configuration.

Show child attributes

string<uuid> | null

is_active

boolean

default:false

updated_at

string<date-time> | null

The date and time the entity was last updated.

video

object

Schema for video placement. It contains specifications for video placement formats, and other video-related properties.

Show child attributes

Update a placementUpdates an existing placement with new information and returns the updated placement details.

⌘I

Create a placement

curl --request POST \
  --url https://your_a2_service/placements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaign_permission": {
    "black": [],
    "white": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "display": {
    "clktype": 1,
    "displayfmt": {
      "ext": {},
      "h": 250,
      "w": 300
    },
    "h": 250,
    "mime": [],
    "nativefmt": {
      "ext": {}
    },
    "w": 300
  },
  "ext": {
    "approval_method": "admin",
    "display": {
      "enabled": 0
    },
    "native": {
      "enabled": 0
    },
    "payout": "rates",
    "responsive": "fixed",
    "target_ecpm": 0,
    "video": {
      "enabled": 0
    }
  },
  "is_active": false,
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "video": {
    "clktype": 1,
    "ctype": [
      2
    ],
    "delay": 0,
    "h": 300,
    "linear": 0,
    "maxdur": 0,
    "mime": [],
    "mindur": 0,
    "playmethod": [],
    "ptype": 1,
    "skip": 0,
    "skipafter": 0,
    "skipmin": 0,
    "w": 480
  }
}'

{
  "campaign_permission": {
    "black": [],
    "white": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "display": {
    "clktype": 1,
    "displayfmt": {
      "ext": {},
      "h": 250,
      "w": 300
    },
    "h": 250,
    "mime": [],
    "nativefmt": {
      "ext": {}
    },
    "w": 300
  },
  "ext": {
    "approval_method": "admin",
    "display": {
      "enabled": 0
    },
    "native": {
      "enabled": 0
    },
    "payout": "rates",
    "responsive": "fixed",
    "target_ecpm": 0,
    "video": {
      "enabled": 0
    }
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": false,
  "name": "<string>",
  "no": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "video": {
    "clktype": 1,
    "ctype": [
      2
    ],
    "delay": 0,
    "h": 300,
    "linear": 0,
    "maxdur": 0,
    "mime": [],
    "mindur": 0,
    "playmethod": [],
    "ptype": 1,
    "skip": 0,
    "skipafter": 0,
    "skipmin": 0,
    "w": 480
  }
}

Data Management APIs

Decision APIs

Authorizations

Body

Response